home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / idl / nsISeekableStream.idl < prev    next >
Encoding:
Text File  |  2006-05-08  |  3.4 KB  |  103 lines
  1. /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
  2. /* ***** BEGIN LICENSE BLOCK *****
  3.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  4.  *
  5.  * The contents of this file are subject to the Mozilla Public License Version
  6.  * 1.1 (the "License"); you may not use this file except in compliance with
  7.  * the License. You may obtain a copy of the License at
  8.  * http://www.mozilla.org/MPL/
  9.  *
  10.  * Software distributed under the License is distributed on an "AS IS" basis,
  11.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12.  * for the specific language governing rights and limitations under the
  13.  * License.
  14.  *
  15.  * The Original Code is Mozilla FastLoad code.
  16.  *
  17.  * The Initial Developer of the Original Code is
  18.  * Netscape Communications Corporation.
  19.  * Portions created by the Initial Developer are Copyright (C) 2001
  20.  * the Initial Developer. All Rights Reserved.
  21.  *
  22.  * Contributor(s):
  23.  *
  24.  * Alternatively, the contents of this file may be used under the terms of
  25.  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26.  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27.  * in which case the provisions of the GPL or the LGPL are applicable instead
  28.  * of those above. If you wish to allow use of your version of this file only
  29.  * under the terms of either the GPL or the LGPL, and not to allow others to
  30.  * use your version of this file under the terms of the MPL, indicate your
  31.  * decision by deleting the provisions above and replace them with the notice
  32.  * and other provisions required by the GPL or the LGPL. If you do not delete
  33.  * the provisions above, a recipient may use your version of this file under
  34.  * the terms of any one of the MPL, the GPL or the LGPL.
  35.  *
  36.  * ***** END LICENSE BLOCK ***** */
  37.  
  38.  
  39. /*
  40.  * nsISeekableStream
  41.  *
  42.  * Note that a stream might not implement all methods (e.g., a readonly stream 
  43.  * won't implement setEOF)
  44.  * 
  45.  * @status UNDER_REVIEW
  46.  */
  47.  
  48. #include "nsISupports.idl"
  49.  
  50. [scriptable, uuid(8429d350-1040-4661-8b71-f2a6ba455980)]
  51. interface nsISeekableStream : nsISupports
  52. {
  53.     /* 
  54.      * Sets the stream pointer to the value of the 'offset' parameter 
  55.      */
  56.     const PRInt32 NS_SEEK_SET = 0;
  57.  
  58.     /*  
  59.      * Sets the stream pointer to its current location plus the value 
  60.      * of the offset parameter. 
  61.      */
  62.     const PRInt32 NS_SEEK_CUR = 1;
  63.  
  64.     /* 
  65.      * Sets the stream pointer to the size of the stream plus the value 
  66.      * of the offset parameter. 
  67.      */
  68.     const PRInt32 NS_SEEK_END = 2;
  69.  
  70.     /**
  71.      *  seek
  72.      *
  73.      *  This method moves the stream offset of the steam implementing this
  74.      *  interface.
  75.      *
  76.      *   @param whence specifies how to interpret the 'offset' parameter in
  77.      *                 setting the stream offset associated with the implementing
  78.      *                 stream.
  79.      *     
  80.      *   @param offset specifies a value, in bytes, that is used in conjunction
  81.      *                 with the 'whence' parameter to set the stream offset of the 
  82.      *                 implementing stream.  A negative value causes seeking in 
  83.      *                 the reverse direction.
  84.      */
  85.     void seek(in long whence, in long long offset);
  86.  
  87.     /**
  88.      *  tell
  89.      *
  90.      *  This method reports the current offset, in bytes, from the start of the 
  91.      *  stream. 
  92.      */
  93.     long long tell();
  94.  
  95.  
  96.     /**
  97.      *  setEOF
  98.      *
  99.      *  This method truncates the stream at the current offset.
  100.      */
  101.     void setEOF();
  102. };
  103.